home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 2001 March / macformat-101.iso / mac / Shareware / DownloadAssistant 2.6.3 / Documentation / User Manual 2.6.3 < prev    next >
Encoding:
Text File  |  2000-10-03  |  21.2 KB  |  447 lines  |  [ttro/ttxt]

  1. DownloadAssistant Script 2.6.3
  2.  
  3. Allows you to leave your computer during downloads
  4. – safely. For any internet protocol and any application.
  5.  
  6. • Rated 5 stars by many users at versionTracker.com
  7. • Rated 4 cows by Tucows.com
  8. • Selected by the MacScripter.net web site
  9. • Selected by MacWorld and Internet.Works
  10. • Rated "Excellent" by Cuneyt.pair.com
  11.  
  12. What users are saying about DA
  13.  
  14. <<           I really love your script and use it almost nightly as I tend to
  15.                         download files late and really appreciate being able to leave the computer
  16.                      unattended and knowing that your script will reliably disconnect and shut it
  17.                         down when the downloads are complete. [...]             >>
  18.                 — Robert Burns - Batavia, New York, U.S.A.
  19.  
  20. <<                  The best script ever written. [...]            >>
  21.                 — Marc Zimmerman - Lyon, France
  22.  
  23.  
  24. Overview
  25.  
  26. With this program you can start your downloads using any protocol (ftp, hotline, carracho, http,…) and any application (Internet Explorer, Netscape, Hotline Client,…) and leave the computer alone securely. DownloadAssistant will automatically disconnect, then activate sleep or shutdown.
  27.  
  28. DA helps prevent pirate intrusions into your system by reducing useless connection time.
  29.  
  30. You can set the english speech synthesizer so DownloadAssistant will give you audio feedback of the download status (very useful if you are away from your computer!) This function works with DA in foreground or background.
  31.  
  32. DA can expand files automatically with Stuffit Expander™ after disconnection and before shutdown. Saves time!
  33.  
  34. It can generate a helpful log file to record what it did for you and when.
  35.  
  36.  
  37. What the program does
  38.  
  39. DownloadAssistant Script disconnects, then activates shutdown or sleep when: 
  40.  
  41. • ALL DOWNLOADS ARE COMPLETE
  42. The "Disconnect if idle for x minutes" option of the "Remote Access" control panel requires that line activity be nil to allow disconnection. In some cases (with Hotline, for instance) this option is unreliable. DownloadAssistant knows when your downloads are complete and disconnects/shuts down safely, no matter what the line traffic is.
  43.  
  44. • THE TRANSFER RATE IS TOO LOW
  45. Rates may be good when you start, but can decrease significantly over time. If you don't want a slow transfer rate (because you pay for calls, for instance), you can ask DownloadAssistant to act when the rate is below your specified value for a specified amount of time. Useful, because many applications can resume downloads (Internet Explorer, Hotline,…).
  46.  
  47. • THE DOWNLOAD PROCESS IS INTERRUPTED IN ANY WAY
  48. If no more data comes from the server(s), DownloadAssistant disconnects, even if line activity is not zero.
  49.  
  50.  
  51. Registration
  52.  
  53. It is $8 ONLY!
  54.  
  55. The demo version monitors for about 60 minutes, then quits automaticaly.  With a registered copy, the time limitation is removed, so you can start your downloads and go out, go to bed, whatever you want!
  56. Updates to 2.x versions will be FREE for any registered user.
  57.  
  58. Registrations are handled by the famous Kagi Shareware service.
  59. If you pay with your credit card, you will receive your registration code within 4 hours only.
  60.  
  61. • YOU CAN REGISTER ONLINE USING THE KAGI's SECURE SERVER
  62.  
  63. Connect to https://order.kagi.com/?16M
  64.  
  65.  
  66. • OR... YOU CAN USE THE ENCLOSED "REGISTER" APPLICATION
  67.  
  68. It generates a form you can e-mail, fax or mail.
  69.  
  70.  
  71.  
  72.  
  73. If you have a problem registering, e-mail me at: fbianchi.dev@infonie.be
  74.  
  75.  
  76. How to use DA
  77.  
  78. 1) OPEN DOWNLOADASSISTANT
  79.  
  80. Double-click on the DA icon.
  81.  
  82. The first time you run DA, you must immediately set the Preferences. These are saved for the next launch, but during subsequent runs, the startup dialog box appears, rather than the Preferences. Click on "Preferences..." to modify them (Preferences will be explained below).
  83.  
  84. Startup Dialog Box:
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104. 2) CLICK THE "START MONITORING" BUTTON
  105.  
  106. DownloadAssistant now continually monitors the folder you selected in Preferences as the download location.
  107. If you want to cancel operation, simply select Quit in the File menu.
  108.  
  109. If you use MacOS 8.6 or higher and you keep DA in the FOREGROUND, it displays information about the download process approximately EVERY MINUTE in the following status window (you don’t have to click "Close Now"— it closes itself after 10 seconds):
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125. However, DownloadAssistant was designed to run perfectly in the background.
  126.  
  127. TIP: with versions of MacOS prior to 8.6, this alert is not displayed (due to a limitation of older versions of AppleScript); however, you can open the log file with SimpleText (see below) during monitoring to check progress.
  128.  
  129.             - Location: the download destination (a folder or the desktop) DA is monitoring. It should be where your applications download to. You can select the location in Preferences.
  130.             - Rate: the rate of data received in the previous minute; this information is very accurate
  131.             - Mean Rate: the mean rate of data received in the 15 previous minutes. Unavailable during the first 14 minutes
  132.             - Status: could be "OK" or:
  133.                                         - "waiting for start": when a download has not started yet
  134.                                         - "low rate": if the rate is below the minimum selected in Preferences (default is "2")
  135.                                         - "checking for termination": if DA is checking for a dropped or terminated connection
  136.                                         - "checking for completion": if DA is checking for downloads completion (when the rate is 0 Kb/s)
  137.  
  138.  
  139. 3) START YOUR DOWNLOAD(S) WITH YOUR APPLICATION(S): Internet Explorer, Netscape, Hotline, Carracho… ANY application(s)!
  140.  
  141. With MacOS 8.6 or higher, before disconnecting, DownloadAssistant displays an alert asking you to confirm the disconnection. If you don't give an answer, DA proceeds 30 seconds later.
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158. DownloadAssistant will faithfully watch over the download process! It will disconnect for you (and activate Sleep or Shutdown if you want). Enjoy!
  159.  
  160.  
  161. Preferences explained
  162.  
  163. Click the "Preferences…" button in the startup dialog to display the Preferences list. Choose a setting and click "Set This…" to modify it (with MacOS versions prior to 8.6, this list is not displayed and all Preference dialogs will open consecutively). 
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190. TIP: in the Preference dialogs, the default button (with the frame around it) will give you the setting you chose previously (i.e. the current setting). So, if you don't want to modify a setting, just press Return.
  191.  
  192.  
  193. • LAST ACTION:
  194.  
  195. After DA disconnects from the internet, it can activate shutdown or sleep. Select the option you want. Some computers cannot be put to sleep; they will be shut down instead.
  196.  
  197. If you ask DownloadAssistant to activate shutdown, quit as many applications as possible before leaving your computer. Some applications cannot be closed automatically (especially if you did not save a modified document). If you forget this, DownloadAssistant will disconnect anyway, but may not be able to activate shutdown! For sleep, you may be able to leave some things running and come back to work later, but be aware that some apps will prevent or disturb sleep. 
  198.  
  199. If you have created a Ram Disk, drag all items located on it to the trash, and empty the trash before leaving your computer. MacOS cannot shut down without a manual confirmation of the loss of the contents of the Ram Disk.
  200.  
  201. Important! This software uses the Apple Open Transport services. If you don't use Open Transport to connect to the internet (for instance, you use FreePPP), you cannot choose "Disconnect" as Last Action. You MUST choose "Shut Down"! If you don't know if you use Open Transport, connect to the internet as you normally do and open the "Remote Access" control panel (or the "PPP" control panel with MacOS prior to 8.5). If you can see a button named "Disconnect," you are using Open Transport.
  202.  
  203.  
  204. • LOW RATE MONITORING:
  205.  
  206. If you want DA to disconnect when the transfer rate drops below a certain value, enter a minimum rate in the first dialog and click "OK." Another dialog appears immediately, asking for the delay period before disconnection. If, at the end of the delay period, the rate is still below the value set in the first dialog, DA will disconnect.
  207. If you don't want to use this feature, enter "any" in the first dialog (the second one will not appear).
  208.  
  209.  
  210. • DELAY BEFORE LAST ACTION:
  211.  
  212. DA interprets "3 minutes of connection without any byte downloaded" as a procedure termination (or an error). If you want to increase or decrease this value, you can modify it here.
  213.  
  214.  
  215. • SOUND NOTIFICATION:
  216.  
  217. -    "None":
  218.             DA doesn't use any sound notification.
  219.  
  220. -    "Alert Sound":
  221.             DA uses the alert sound (known as "the beep") you choose in the "Sound" (or "Monitors & Sound") control panel.
  222.             If DA is in the foreground, it beeps every time it displays the status window (about every minute). Otherwise, it doesn't.
  223.             In the foreground or in the background, it beeps 5 times before disconnecting.
  224.  
  225. -    "Voice":
  226.             If you use MacOS 8.6 or later, and you installed the Speech Recognition package from your MacOS CD, you can use this option.
  227.       If DA is in the foreground, it beeps every time it displays the status window if the state is "OK"; if it's in the background, it doesn't.
  228.             In the foreground or in the background, it says:
  229.                             - "waiting for start": when downloads are not started yet;
  230.                             - "low rate": if the rate is below the minimum rate you selected, if any;
  231.                             - "checking for completion": if DA is checking for downloads completion (when the rate is 0 Kb/s);
  232.                             - "now, rainy days are gone": if the rate recovers sufficiently after a "low rate" period;
  233.                             - an appropriate sentence before disconnecting.
  234.  
  235. If you want to use another voice, open the "Speech" control panel and select another one.
  236. Do not check "Speak the phrase" or "Speak the alert text" in the Speech control panel. This interferes with the process.
  237.  
  238.  
  239. • LOG FILE GENERATION:
  240.  
  241. If you choose "Yes," when you click on the "Start Monitoring" button, DA will generate a log file in a folder named "DA Logs ƒ" that it creates on the root of your startup disk.
  242. You can view it and print it with SimpleText or any other text editor.
  243.  
  244. The log file is named in the form "<the date> — <a reference number>."
  245. The most recent log file of a given day has the highest reference number.
  246. It is a good idea to sort the log files in the Finder by creation or modification dates.
  247.  
  248. In the log file, you can find data like "low rate" notifications, mean rate (every 15 minutes), connection speed in bauds, disconnection time, total bytes dowloaded during session, and others.
  249.  
  250. TIP: You can open the log file with SimpleText even during monitoring, but you have to close and open it again for it to be updated.
  251.  
  252.  
  253. • AUTO DECOMPRESS:
  254.  
  255. If you choose "Yes," DA will decode and expand the files found in the download location after disconnecting. DA uses Stuffit Expander™.
  256. The expanded files will be found in a folder named "DA Expanded files" on your desktop. If this folder doesn't exist, DA will create it.
  257. This feature is useful with applications that don't handle auto-decompression (as HL Client)
  258.  
  259. Tips: You can stop this process: just type command-.
  260.  
  261. Warning! The original encoded and compressed files (in the download location) are deleted.
  262.  
  263.  
  264. • DOWNLOAD LOCATION:
  265.  
  266. DA has to know in which folder you store your downloads: this is the "Download Location" (i.e. the folder where your applications download to). You can select the desktop instead of a folder, but you cannot select an entire disk.
  267.  
  268. Note: For the Hotline Client application, the download location is the "Downloads" folder in the HL Client folder itself.
  269.  
  270. Remember: DA works better with a download folder that contains few items in its hierarchy. It checks this folder right after selection, and again during lauching of the script, to be sure the folder is not overloaded (in which case, the System could be slowed down). If it is, DA alerts you. It is a good idea to keep this folder clean.
  271.  
  272. TIPS: 
  273. You can download more than one file simultaneously.
  274.  
  275. You can even use more than one application to download at the same time—simply download to the same location. There are two cases:
  276.             1) - the application you want to use does not let you choose the download folder you want (for instance, Hotline Client) because it uses its own download folder.
  277. - Create a folder on the desktop (or other location).
  278. - For each application of this kind, replace its OWN download folder (i.e., "Downloads" for Hotline) with an ALIAS of the folder you have just created on the desktop, but give it exactly the same name, i.e., "Downloads" for Hotline. Thus, each specially named alias points to the same original folder.
  279.             2) - the application can let you choose a download folder (for instance, Internet Explorer). Simple: choose the folder you created on the desktop.
  280. So now, every application downloads to the same folder.
  281.  
  282. IMPORTANT! Do not modify the content of the download folder while DownloadAssistant is running. (this can shuffle the transfer rate it calculates)!
  283.  
  284.  
  285. Troubleshooting
  286.  
  287. You may see one of the following:
  288.  
  289. - "Requires the standard additions dictionary"
  290. One or more AppleScript dictionaries (in the "Scripting Additions" folder of your system folder) are missing. Re-install AppleScript from your MacOS CD, using an AppleScript standard installation.
  291.  
  292. - "Requires the remote access commands dictionary"
  293. If you use MacOS 8.6 or later, the "Remote Access Commands" dictionary (in the "Scripting Additions" folder of your system folder) is missing. Re-install Apple Remote Access (ARA) from your MacOS CD, using an ARA standard installation.
  294. If you use an older version of MacOS, the "PPP Commands" dictionary (in the "Scripting Additions" folder of your system folder) is missing. Re-install OpenTransport/PPP from your MacOS CD, using an OpenTransport/PPP standard installation.
  295.  
  296. - A "Type -127 (or -241) error" occured or "Out of memory" is displayed:
  297. You may need to increase the memory allocated to DownloadAssistant (the speech synthesizer is memory-consuming).
  298.  
  299. - The "Voice" option does not work:
  300. In MacOS 8.6 or higher, the Speech control panel (part of the English Speech Recognition package), and the Speech Manager extension are required to use the "Voice" option. If these items  don't load at startup, open the Extensions Manager control panel to activate them, then restart. If you cannot find them in the list, you have to install them from your Mac OS CD.
  301. Do not check "Speak the phrase" or "Speak the alert text" in the Speech control panel.
  302.  
  303. - A problem about "PrefsLib" or "ExpandLib":
  304. The folder "DA Required" must be in the same folder as DownloadAssistant. It must not be renamed. Files located in it must not be renamed.
  305.  
  306. - Other errors should be clearly displayed, but if you have a problem, report error messages and circumstances at: fbianchi.dev@infonie.be
  307.  
  308.  
  309. How this software was made
  310.  
  311. It is a compiled script written with the AppleScript language
  312. — just more complicated than the majority of them.
  313.  
  314.  
  315. Requirements
  316.  
  317. MacOS 7.5 or later with AppleScript installed.
  318. AppleScript is a default component of Mac OS (if it was not installed, you can find it in your MacOS CD). 
  319.  
  320. Some limitations from MacOS 7.5 to 8.5 (read the user manual).
  321. MacOS 8.6 or later and English Speech Recognition Package (on your  Mac OS CD) is required for the "Voice" option.
  322.  
  323. Tested on MacOS 8.1, MacOS 8.6 and MacOS 9.0
  324. Should work on MacOS 7.5, but I couldn't test it.
  325.  
  326.  
  327. License
  328.  
  329. $8 Shareware
  330. See the license agreement.
  331. Do not modify this software. Do not modify the user manual.
  332. Do not use this software to assist the download of illegal information and/or illegal software.
  333. Commercial distribution of any version not allowed without written permission.
  334. Upload of any version not allowed without written permission.
  335. Do not copy the text of this document.
  336. Software and user manual, Copyright © 2000 by Fabrice Bianchi, all rights reserved.
  337.  
  338.  
  339. Support / Updates
  340.  
  341. Send questions, bug reports, criticism (or encouragement!) to:
  342. fbianchi.dev@infonie.be   or  fbianchi.dev@kagi.com
  343. I try to answer every message but I always answer to registered users first, in the order messages arrive.
  344. If you encounter a problem, please do not flame the product at versionTracker. It does not help the product, and it does not help me, so it does not help you. Please, e-mail me your problem first!
  345.  
  346. You can download updates at web site:
  347. http://perso.infonie.be/fbianchi  or try  http://perso.infonie.fr/fbianchi 
  348.  
  349. You like this software?
  350. Please, write something kind about it at http://www.versionTracker.com
  351. Thank you!
  352.  
  353.  
  354. Thanks
  355.  
  356. For the corrections they made in the text of the manuals and in the text displayed by the software, for their advices, my gratitude to:
  357.  
  358. - Lawrence, Peter and Bob for the 1.x versions
  359.  
  360. - Peter for the 2.x versions. Check his web site at www.geminipress.com !
  361.  
  362.  
  363.  
  364. Stuffit Expander™ is a trademark of Aladdin Systems.
  365.  
  366.  
  367. Version History
  368.  
  369. 1.0.1, March, 7th 2000
  370. - first public release
  371.  
  372. 1.1
  373. - no more time-trial
  374.  
  375. 1.2
  376. -    one minor bug corrected
  377.  
  378. 1.3 to 1.3.1
  379. - help dialogs added for first-time users
  380. - one more error check
  381.  
  382. 1.5
  383. - support for the english voice synthesizer
  384. - requires less processor-cycles during monitoring
  385. - preferences support rewritten (file support and interface)
  386.  
  387. 1.6.0 to 1.6.6
  388. - monitoring procedure optimised
  389. - you can now put your PowerBook or your iBook to sleep when downloads are complete
  390. - with the "Voice" option selected, should the rate recover sufficiently after a "low rate" period that hasn't reached the set time limit, you are notified by the voice synthesizer: "Now rainy days are gone."
  391. - DownloadAssistant now checks the target download folder right after selection, and again during lauching of the script, to be sure the folder is not overloaded (in which case, the System could be slowed down). If it is, it alerts you.
  392. - in previous versions, if you selected a disk (root level) as the download folder, and the disk wasn't mounted at startup or its name had been modified, DownloadAssistant used the root level of the startup disk as the new download folder without displaying an error. This seemed to freeze the computer. Now if the selected disk is not found, the script displays a dialog asking the user to locate it or to locate another folder.
  393. - the way DownloadAssistant checks for the Remote Access Commands dictionary might not work in some circumstances. This has been corrected (1.6.5).
  394. - "Cancel" buttons added in dialogs where possible (1.6.5).
  395. - bad support for real numbers with non-English versions of Mac OS corrected (1.6.5).
  396. - due to a bug I had to correct, version 1.6.5 may be used until 1st September 2000. Version 1.6.6 is not time-trial.
  397. - spelling mistakes corrected in software and ReadMe (1.6.1 and 1.6.5).
  398.  
  399. 2.0 to 2.0.3
  400. - now, DA can monitor the desktop — for everyone that uses the desktop as download location
  401. - DA can create a great log file on your startup disk.
  402. When the day is breaking, you can consult the log to know what DA did for you last night… and when. Moreover, DA reports the mean transfer rate, every 15 minutes, in the log file
  403. - DA displays in the main window a summary of your preferences. You do not have to check them any more!
  404. - with newest versions of MacOS, previous versions of DA could not shut down the computer in some cases. This has been corrected in this version
  405. - some optimisations
  406. - the demo version monitors during 60 minutes now (2.0.1)
  407. - one minor bug fix (thanks to Marc) and more messages in the log file (2.0.2)
  408. - mean rate (every 15 minutes) displayed and better memory handling (2.0.3).
  409.  
  410. 2.1
  411. - bug fix that prevents DA to run under some MacOS versions ("Folder HD:System Folder:Preferences:DownloadAss Script Prefs wasn't found." displayed).
  412. - serial number displayed (as requested by numerous users)
  413. - minor internal optimisation
  414.  
  415. 2.5 to 2.5.2
  416. - can work now on MacOS 7.5 and higher (from 7.5 to 8.5 with some limitations; fully on 8.6 and higher)
  417. - self-extracting archive
  418. - new very detailed user guide
  419. - delay before disconnection is now 3 minutes (instead of 5)
  420. - minor bug fixes and modifications
  421. - bug fix that prevents DA to run on some versions of MacOS 9 (2.5.1)
  422. - bug fix that prevents the demo version (non-registered versions only!) to monitor during true 60 minutes (2.5.2)
  423.  
  424. 2.6
  425. - DownloadAssistant can decode and expand files automatically with Stuffit Expander™ after disconnection.
  426. - You can modify the delay before disconnection when no more data is received
  427. - Generate a new log file won't delete the previous one: DA now keeps previous logs in a folder
  428. - when DA was in the background and the "Voice" option is used, DA beeps every minute. This bug has been fixed
  429. - Some debugging information was still displayed in the preferences (when you choose a folder as download location, the path to this folder was displayed in a dialog). This bug has been fixed
  430. - one minor bug fixed in the preferences handling
  431.  
  432. 2.6.2
  433. - DA doesn't display an "AppleEvent timed out" error message any more (this problem appeared when the computer is too busy to let the Finder reply to a DA's query)
  434. - in previous versions, DA quits all applications before putting to sleep the computer. This bug has been fixed
  435. - the total bytes download info wasn't properly displayed in the log file. This bug has been fixed
  436. - you can stop the unstuff process of files: type command-.
  437. - many manual corrections thanks to Peter
  438. - a low memory problem that could occur with the speech manager is now fixed
  439. - a problem with log files generation on MacOS 8.5 and older has been fixed
  440. - two minor bugs fixed in the preferences handling
  441.  
  442. -------------------------------------------------------
  443. DA User Manual 2.6.3
  444. Copyright © 2000 Fabrice Bianchi, all rights reserved
  445. Bruxelles, Belgium — October, 3 2000
  446.  
  447.